Skip to content

REST API: Restore the global post after preparing a revision#12248

Open
MicahelE wants to merge 1 commit into
WordPress:trunkfrom
MicahelE:fix/65495-revisions-controller-post-leak
Open

REST API: Restore the global post after preparing a revision#12248
MicahelE wants to merge 1 commit into
WordPress:trunkfrom
MicahelE:fix/65495-revisions-controller-post-leak

Conversation

@MicahelE

Copy link
Copy Markdown

Trac: https://core.trac.wordpress.org/ticket/65495

WP_REST_Revisions_Controller::prepare_item_for_response() sets the global $post and calls setup_postdata(), but never restores them, so the change leaks for the rest of the request.

The autosaves controller delegates here, and the block editor preloads /autosaves on every load. When the post has a pending autosave, the global $post is left pointing at the autosave, so the editor can initialize with the wrong post id and redirect to it. That presents as the editor randomly opening a different post.

This captures the previous global $post and restores it on every return path (including the HEAD early return), which also covers the autosaves endpoint.

Reproduction (no browser):

wp eval '
$pid = wp_insert_post( array( "post_status" => "publish" ) );
wp_create_post_autosave( array( "post_ID" => $pid, "post_content" => "x", "post_type" => "post" ) );
global $post; $post = get_post( $pid ); setup_postdata( $post );
rest_get_server()->dispatch( new WP_REST_Request( "GET", "/wp/v2/posts/$pid/autosaves" ) );
echo $GLOBALS["post"]->ID === $pid ? "OK" : "LEAKED";
'

Before: LEAKED. After: OK.

Tests: Adds coverage for the restore (GET, HEAD, and the no-global-post case). The existing "sets up postdata" tests were asserting the leak, so they now confirm rendered fields still reflect the revision while the global post is restored.

WP_REST_Revisions_Controller::prepare_item_for_response() set the global $post and called setup_postdata() without restoring them, so the change leaked for the rest of the request. The autosaves controller delegates here, so preloading that endpoint in the block editor could leave the global $post pointing at an autosave and initialize the editor with the wrong post.

Capture the previous global post and restore it on every return path. Update the existing "sets up postdata" tests to confirm rendered fields still reflect the revision while the global post no longer leaks.

Fixes #65495.
@github-actions

Copy link
Copy Markdown

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props micahele.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions

Copy link
Copy Markdown

Hi there! 👋

Thank you for your contribution to WordPress! 💖

It looks like this is your first pull request to wordpress-develop. Here are a few things to be aware of that may help you out!

No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description.

Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making.

More information about how GitHub pull requests can be used to contribute to WordPress can be found in the Core Handbook.

Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook.

If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook.

The Developer Hub also documents the various coding standards that are followed:

Thank you,
The WordPress Project

@github-actions

Copy link
Copy Markdown

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant